MouseEventParams

The DOM mouse event parameters.

Inheritors

Types

Link copied to clipboard
class Builder
A builder of MouseEventParams.

Functions

Link copied to clipboard
Returns a button pressed during events caused by pressing or releasing one or multiple buttons.
Link copied to clipboard
open fun clickCount(): Int
Returns the count of consecutive clicks that happened in a short amount of time for mouse events, such as "click", "mouseDown, "mouseUp".
Link copied to clipboard
open fun clientLocation(): Point
Returns the location of the mouse cursor in the local (DOM content) coordinate system at the time the event occurred.
Link copied to clipboard
open fun isBubbles(): Boolean
Returns true if the event bubbles up through the DOM.
Link copied to clipboard
open fun isCancelable(): Boolean
Returns true if the event can be canceled, and therefore prevented as if the event never happened.
Link copied to clipboard
open fun isTrusted(): Boolean
Returns true if the event is trusted, and therefore was generated by a user action.
Link copied to clipboard
Returns the key modifiers that are applied to the event.
Link copied to clipboard
Creates a new MouseEventParams builder.
Link copied to clipboard
open fun offsetLocation(): Point
Returns the location of the mouse cursor in the component's coordinate system at the time the event occurred.
Link copied to clipboard
open fun pageLocation(): Point
Returns the location of the mouse cursor in the document coordinate system at the time the event occurred.
Link copied to clipboard
open fun screenLocation(): Point
Returns the location of the mouse cursor in the screen's coordinate system at the time the event occurred.